Runtime: Expose readonly directly off the datastore runtime #24410
+494
−16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
base: main
…to ro/datastore-readonly
github-actions
bot
added
area: framework
…to ro/datastore-readonly
github-actions
bot
added
the
area: framework
There was a problem hiding this comment.
Pull Request Overview
This PR exposes the datastore runtime’s readonly flag and readonly event from the container runtime to reduce reliance on the delta manager. Key changes include adding a new feature constant (setReadonly) in the runtime definitions, propagating the readonly event in the FluidDataStoreRuntime, and updating tests and compatibility checks accordingly.
Reviewed Changes
Copilot reviewed 27 out of 29 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/runtime/runtime-definitions/src/runtimeLayerCompatFeatureNames.ts | Added a new constant (setReadonly) to expose readonly functionality. |
| packages/runtime/runtime-definitions/src/index.ts | Updated exports to include the new setReadonly feature. |
| packages/runtime/runtime-definitions/src/dataStoreContext.ts | Added optional setReadOnlyState method and readonly flag to context interfaces. |
| packages/runtime/datastore/src/dataStoreRuntime.ts | Implemented a getter for readonly and setReadOnlyState to propagate updates. |
| packages/runtime/container-runtime/src/dataStoreContext.ts | Introduced ContextDeltaManagerProxy to shim readonly state for backward compatibility. |
| Other test and API-report files | Updated to include the new readonly functionality and compatibility markers. |
Files not reviewed (2)
- packages/framework/aqueduct/package.json: Language not supported
- packages/runtime/datastore/package.json: Language not supported
Comments suppressed due to low confidence (1)
packages/runtime/runtime-definitions/src/runtimeLayerCompatFeatureNames.ts:18
- [nitpick] The naming for the readonly feature is inconsistent with other related methods (e.g. setReadOnlyState, get readonly) where 'ReadOnly' is camel-cased. Consider renaming the constant to 'setReadOnly' for consistency.
export const setReadonly = "setReadonly" as const;
markfields
reviewed
Apr 22, 2025
markfields
reviewed
Apr 22, 2025
markfields
reviewed
Apr 22, 2025
markfields
reviewed
Apr 22, 2025
markfields
reviewed
Apr 22, 2025
markfields
reviewed
Apr 22, 2025
Co-authored-by: Mark Fields <markfields@users.noreply.github.com>
ChumpChief
reviewed
Apr 22, 2025
Co-authored-by: Kian Thompson <102998837+kian-thompson@users.noreply.github.com>
Co-authored-by: Matt Rakow <ChumpChief@users.noreply.github.com>
…rphy/FluidFramework-1 into ro/datastore-readonly
…to ro/datastore-readonly
jason-ha
reviewed
Apr 23, 2025
jason-ha
reviewed
Apr 23, 2025
ChumpChief
reviewed
Apr 23, 2025
anthony-murphy
force-pushed
the
ro/datastore-readonly
branch
from
3f52a4f to
0b0ccc3
Compare
anthony-murphy
force-pushed
the
ro/datastore-readonly
branch
from
0b0ccc3 to
c27695d
Compare
jason-ha
approved these changes
Apr 23, 2025
Josmithr
reviewed
Apr 23, 2025
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
ChumpChief
approved these changes
Apr 23, 2025
There was a problem hiding this comment.
The plumbing across layers is a bit painful (i.e. taking different shapes, mechanisms, optionalities, etc.) but I don't think significantly moreso than for connection state. Not sure what the solution looks like, but I suppose if we manage to solve it for one we'll solve it for the other too.
Abe27342
approved these changes
Apr 23, 2025
jason-ha
reviewed
Apr 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change plumbs through the readonly flag from the container runtime to the data store runtime. This will reduce reliance on the delta manager in datastores as one of the primary reasons it is used is to retrieve the readonly flag. In addition to the flag, this change also propagates the readonly event, so changes can be detected.
In order to be backward compatible, there is code in the DataStoreContext which ensures that the readonly flag is correctly set for older data stores. In the FluidDataStoreRuntime this is code to handle context's which do and don't support setting readonly. These together ensure a consistent experience for developers, regardless of the versions they are using.
The primary motivation for this change is to leverage readonly to deal with back and forward compat between layers, as we can build upon this to support putting specific datastore into readonly if they do not support some feature. I plan to leverage this for staging mode, so datastores which should not submit changes during staging mode, can be placed in readonly.
AB#32463